<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.configuration;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import static org.junit.Assert.assertEquals;<a name="line.19"></a>
<FONT color="green">020</FONT>    import static org.junit.Assert.fail;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    import java.awt.event.KeyEvent;<a name="line.22"></a>
<FONT color="green">023</FONT>    import java.util.List;<a name="line.23"></a>
<FONT color="green">024</FONT>    <a name="line.24"></a>
<FONT color="green">025</FONT>    import org.apache.commons.configuration.interpol.ConfigurationInterpolator;<a name="line.25"></a>
<FONT color="green">026</FONT>    import org.apache.commons.lang.text.StrLookup;<a name="line.26"></a>
<FONT color="green">027</FONT>    <a name="line.27"></a>
<FONT color="green">028</FONT>    /**<a name="line.28"></a>
<FONT color="green">029</FONT>     * A helper class that defines a bunch of tests related to variable<a name="line.29"></a>
<FONT color="green">030</FONT>     * interpolation. It can be used for running these tests on different<a name="line.30"></a>
<FONT color="green">031</FONT>     * configuration implementations.<a name="line.31"></a>
<FONT color="green">032</FONT>     *<a name="line.32"></a>
<FONT color="green">033</FONT>     * @author &lt;a<a name="line.33"></a>
<FONT color="green">034</FONT>     * href="http://commons.apache.org/configuration/team-list.html"&gt;Commons<a name="line.34"></a>
<FONT color="green">035</FONT>     * Configuration team&lt;/a&gt;<a name="line.35"></a>
<FONT color="green">036</FONT>     * @version $Id: InterpolationTestHelper.java 1222452 2011-12-22 21:06:17Z oheger $<a name="line.36"></a>
<FONT color="green">037</FONT>     */<a name="line.37"></a>
<FONT color="green">038</FONT>    public class InterpolationTestHelper<a name="line.38"></a>
<FONT color="green">039</FONT>    {<a name="line.39"></a>
<FONT color="green">040</FONT>        /**<a name="line.40"></a>
<FONT color="green">041</FONT>         * Tests basic interpolation facilities of the specified configuration.<a name="line.41"></a>
<FONT color="green">042</FONT>         *<a name="line.42"></a>
<FONT color="green">043</FONT>         * @param config the configuration to test<a name="line.43"></a>
<FONT color="green">044</FONT>         */<a name="line.44"></a>
<FONT color="green">045</FONT>        public static void testInterpolation(Configuration config)<a name="line.45"></a>
<FONT color="green">046</FONT>        {<a name="line.46"></a>
<FONT color="green">047</FONT>            config.setProperty("applicationRoot", "/home/applicationRoot");<a name="line.47"></a>
<FONT color="green">048</FONT>            config.setProperty("db", "${applicationRoot}/db/hypersonic");<a name="line.48"></a>
<FONT color="green">049</FONT>            String unInterpolatedValue = "${applicationRoot2}/db/hypersonic";<a name="line.49"></a>
<FONT color="green">050</FONT>            config.setProperty("dbFailedInterpolate", unInterpolatedValue);<a name="line.50"></a>
<FONT color="green">051</FONT>            String dbProp = "/home/applicationRoot/db/hypersonic";<a name="line.51"></a>
<FONT color="green">052</FONT>    <a name="line.52"></a>
<FONT color="green">053</FONT>            assertEquals("Checking interpolated variable", dbProp, config<a name="line.53"></a>
<FONT color="green">054</FONT>                    .getString("db"));<a name="line.54"></a>
<FONT color="green">055</FONT>            assertEquals("lookup fails, leave variable as is", config<a name="line.55"></a>
<FONT color="green">056</FONT>                    .getString("dbFailedInterpolate"), unInterpolatedValue);<a name="line.56"></a>
<FONT color="green">057</FONT>    <a name="line.57"></a>
<FONT color="green">058</FONT>            config.setProperty("arrayInt", "${applicationRoot}/1");<a name="line.58"></a>
<FONT color="green">059</FONT>            String[] arrayInt = config.getStringArray("arrayInt");<a name="line.59"></a>
<FONT color="green">060</FONT>            assertEquals("check first entry was interpolated",<a name="line.60"></a>
<FONT color="green">061</FONT>                    "/home/applicationRoot/1", arrayInt[0]);<a name="line.61"></a>
<FONT color="green">062</FONT>    <a name="line.62"></a>
<FONT color="green">063</FONT>            config.addProperty("path", "/temp,C:\\Temp,/usr/local/tmp");<a name="line.63"></a>
<FONT color="green">064</FONT>            config.setProperty("path.current", "${path}");<a name="line.64"></a>
<FONT color="green">065</FONT>            assertEquals("Interpolation with multi-valued property",<a name="line.65"></a>
<FONT color="green">066</FONT>                    "/temp", config.getString("path.current"));<a name="line.66"></a>
<FONT color="green">067</FONT>        }<a name="line.67"></a>
<FONT color="green">068</FONT>    <a name="line.68"></a>
<FONT color="green">069</FONT>        /**<a name="line.69"></a>
<FONT color="green">070</FONT>         * Tests an interpolation over multiple levels (i.e. the replacement of a<a name="line.70"></a>
<FONT color="green">071</FONT>         * variable is another variable and so on).<a name="line.71"></a>
<FONT color="green">072</FONT>         *<a name="line.72"></a>
<FONT color="green">073</FONT>         * @param config the configuration to test<a name="line.73"></a>
<FONT color="green">074</FONT>         */<a name="line.74"></a>
<FONT color="green">075</FONT>        public static void testMultipleInterpolation(Configuration config)<a name="line.75"></a>
<FONT color="green">076</FONT>        {<a name="line.76"></a>
<FONT color="green">077</FONT>            config.setProperty("test.base-level", "/base-level");<a name="line.77"></a>
<FONT color="green">078</FONT>            config<a name="line.78"></a>
<FONT color="green">079</FONT>                    .setProperty("test.first-level",<a name="line.79"></a>
<FONT color="green">080</FONT>                            "${test.base-level}/first-level");<a name="line.80"></a>
<FONT color="green">081</FONT>            config.setProperty("test.second-level",<a name="line.81"></a>
<FONT color="green">082</FONT>                    "${test.first-level}/second-level");<a name="line.82"></a>
<FONT color="green">083</FONT>            config.setProperty("test.third-level",<a name="line.83"></a>
<FONT color="green">084</FONT>                    "${test.second-level}/third-level");<a name="line.84"></a>
<FONT color="green">085</FONT>    <a name="line.85"></a>
<FONT color="green">086</FONT>            String expectedValue = "/base-level/first-level/second-level/third-level";<a name="line.86"></a>
<FONT color="green">087</FONT>    <a name="line.87"></a>
<FONT color="green">088</FONT>            assertEquals(config.getString("test.third-level"),<a name="line.88"></a>
<FONT color="green">089</FONT>                            expectedValue);<a name="line.89"></a>
<FONT color="green">090</FONT>        }<a name="line.90"></a>
<FONT color="green">091</FONT>    <a name="line.91"></a>
<FONT color="green">092</FONT>        /**<a name="line.92"></a>
<FONT color="green">093</FONT>         * Tests an invalid interpolation that results in an infinite loop. This<a name="line.93"></a>
<FONT color="green">094</FONT>         * loop should be detected and an exception should be thrown.<a name="line.94"></a>
<FONT color="green">095</FONT>         *<a name="line.95"></a>
<FONT color="green">096</FONT>         * @param config the configuration to test<a name="line.96"></a>
<FONT color="green">097</FONT>         */<a name="line.97"></a>
<FONT color="green">098</FONT>        public static void testInterpolationLoop(Configuration config)<a name="line.98"></a>
<FONT color="green">099</FONT>        {<a name="line.99"></a>
<FONT color="green">100</FONT>            config.setProperty("test.a", "${test.b}");<a name="line.100"></a>
<FONT color="green">101</FONT>            config.setProperty("test.b", "${test.a}");<a name="line.101"></a>
<FONT color="green">102</FONT>    <a name="line.102"></a>
<FONT color="green">103</FONT>            try<a name="line.103"></a>
<FONT color="green">104</FONT>            {<a name="line.104"></a>
<FONT color="green">105</FONT>                config.getString("test.a");<a name="line.105"></a>
<FONT color="green">106</FONT>                fail("IllegalStateException should have been thrown for looped property references");<a name="line.106"></a>
<FONT color="green">107</FONT>            }<a name="line.107"></a>
<FONT color="green">108</FONT>            catch (IllegalStateException e)<a name="line.108"></a>
<FONT color="green">109</FONT>            {<a name="line.109"></a>
<FONT color="green">110</FONT>                // ok<a name="line.110"></a>
<FONT color="green">111</FONT>            }<a name="line.111"></a>
<FONT color="green">112</FONT>    <a name="line.112"></a>
<FONT color="green">113</FONT>        }<a name="line.113"></a>
<FONT color="green">114</FONT>    <a name="line.114"></a>
<FONT color="green">115</FONT>        /**<a name="line.115"></a>
<FONT color="green">116</FONT>         * Tests interpolation when a subset configuration is involved.<a name="line.116"></a>
<FONT color="green">117</FONT>         *<a name="line.117"></a>
<FONT color="green">118</FONT>         * @param config the configuration to test<a name="line.118"></a>
<FONT color="green">119</FONT>         */<a name="line.119"></a>
<FONT color="green">120</FONT>        public static void testInterpolationSubset(Configuration config)<a name="line.120"></a>
<FONT color="green">121</FONT>        {<a name="line.121"></a>
<FONT color="green">122</FONT>            config.addProperty("test.a", new Integer(42));<a name="line.122"></a>
<FONT color="green">123</FONT>            config.addProperty("test.b", "${test.a}");<a name="line.123"></a>
<FONT color="green">124</FONT>            assertEquals("Wrong interpolated value", 42, config<a name="line.124"></a>
<FONT color="green">125</FONT>                    .getInt("test.b"));<a name="line.125"></a>
<FONT color="green">126</FONT>            Configuration subset = config.subset("test");<a name="line.126"></a>
<FONT color="green">127</FONT>            assertEquals("Wrong string property", "42", subset<a name="line.127"></a>
<FONT color="green">128</FONT>                    .getString("b"));<a name="line.128"></a>
<FONT color="green">129</FONT>            assertEquals("Wrong int property", 42, subset.getInt("b"));<a name="line.129"></a>
<FONT color="green">130</FONT>        }<a name="line.130"></a>
<FONT color="green">131</FONT>    <a name="line.131"></a>
<FONT color="green">132</FONT>        /**<a name="line.132"></a>
<FONT color="green">133</FONT>         * Tests interpolation when the referred property is not found.<a name="line.133"></a>
<FONT color="green">134</FONT>         *<a name="line.134"></a>
<FONT color="green">135</FONT>         * @param config the configuration to test<a name="line.135"></a>
<FONT color="green">136</FONT>         */<a name="line.136"></a>
<FONT color="green">137</FONT>        public static void testInterpolationUnknownProperty(Configuration config)<a name="line.137"></a>
<FONT color="green">138</FONT>        {<a name="line.138"></a>
<FONT color="green">139</FONT>            config.addProperty("test.interpol", "${unknown.property}");<a name="line.139"></a>
<FONT color="green">140</FONT>            assertEquals("Wrong interpolated unknown property",<a name="line.140"></a>
<FONT color="green">141</FONT>                    "${unknown.property}", config.getString("test.interpol"));<a name="line.141"></a>
<FONT color="green">142</FONT>        }<a name="line.142"></a>
<FONT color="green">143</FONT>    <a name="line.143"></a>
<FONT color="green">144</FONT>        /**<a name="line.144"></a>
<FONT color="green">145</FONT>         * Tests interpolation of system properties.<a name="line.145"></a>
<FONT color="green">146</FONT>         *<a name="line.146"></a>
<FONT color="green">147</FONT>         * @param config the configuration to test<a name="line.147"></a>
<FONT color="green">148</FONT>         */<a name="line.148"></a>
<FONT color="green">149</FONT>        public static void testInterpolationSystemProperties(Configuration config)<a name="line.149"></a>
<FONT color="green">150</FONT>        {<a name="line.150"></a>
<FONT color="green">151</FONT>            String[] sysProperties =<a name="line.151"></a>
<FONT color="green">152</FONT>            { "java.version", "java.vendor", "os.name", "java.class.path" };<a name="line.152"></a>
<FONT color="green">153</FONT>            for (int i = 0; i &lt; sysProperties.length; i++)<a name="line.153"></a>
<FONT color="green">154</FONT>            {<a name="line.154"></a>
<FONT color="green">155</FONT>                config.addProperty("prop" + i, "${sys:" + sysProperties[i] + "}");<a name="line.155"></a>
<FONT color="green">156</FONT>            }<a name="line.156"></a>
<FONT color="green">157</FONT>    <a name="line.157"></a>
<FONT color="green">158</FONT>            for (int i = 0; i &lt; sysProperties.length; i++)<a name="line.158"></a>
<FONT color="green">159</FONT>            {<a name="line.159"></a>
<FONT color="green">160</FONT>                assertEquals("Wrong value for system property "<a name="line.160"></a>
<FONT color="green">161</FONT>                        + sysProperties[i], System.getProperty(sysProperties[i]),<a name="line.161"></a>
<FONT color="green">162</FONT>                        config.getString("prop" + i));<a name="line.162"></a>
<FONT color="green">163</FONT>            }<a name="line.163"></a>
<FONT color="green">164</FONT>        }<a name="line.164"></a>
<FONT color="green">165</FONT>    <a name="line.165"></a>
<FONT color="green">166</FONT>        /**<a name="line.166"></a>
<FONT color="green">167</FONT>         * Tests interpolation of constant values.<a name="line.167"></a>
<FONT color="green">168</FONT>         *<a name="line.168"></a>
<FONT color="green">169</FONT>         * @param config the configuration to test<a name="line.169"></a>
<FONT color="green">170</FONT>         */<a name="line.170"></a>
<FONT color="green">171</FONT>        public static void testInterpolationConstants(Configuration config)<a name="line.171"></a>
<FONT color="green">172</FONT>        {<a name="line.172"></a>
<FONT color="green">173</FONT>            config.addProperty("key.code",<a name="line.173"></a>
<FONT color="green">174</FONT>                    "${const:java.awt.event.KeyEvent.VK_CANCEL}");<a name="line.174"></a>
<FONT color="green">175</FONT>            assertEquals("Wrong value of constant variable",<a name="line.175"></a>
<FONT color="green">176</FONT>                    KeyEvent.VK_CANCEL, config.getInt("key.code"));<a name="line.176"></a>
<FONT color="green">177</FONT>            assertEquals("Wrong value when fetching constant from cache",<a name="line.177"></a>
<FONT color="green">178</FONT>                    KeyEvent.VK_CANCEL, config.getInt("key.code"));<a name="line.178"></a>
<FONT color="green">179</FONT>        }<a name="line.179"></a>
<FONT color="green">180</FONT>    <a name="line.180"></a>
<FONT color="green">181</FONT>        /**<a name="line.181"></a>
<FONT color="green">182</FONT>         * Tests whether a variable can be escaped, so that it won't be<a name="line.182"></a>
<FONT color="green">183</FONT>         * interpolated.<a name="line.183"></a>
<FONT color="green">184</FONT>         *<a name="line.184"></a>
<FONT color="green">185</FONT>         * @param config the configuration to test<a name="line.185"></a>
<FONT color="green">186</FONT>         */<a name="line.186"></a>
<FONT color="green">187</FONT>        public static void testInterpolationEscaped(Configuration config)<a name="line.187"></a>
<FONT color="green">188</FONT>        {<a name="line.188"></a>
<FONT color="green">189</FONT>            config.addProperty("var", "x");<a name="line.189"></a>
<FONT color="green">190</FONT>            config.addProperty("escVar", "Use the variable $${${var}}.");<a name="line.190"></a>
<FONT color="green">191</FONT>            assertEquals("Wrong escaped variable", "Use the variable ${x}.",<a name="line.191"></a>
<FONT color="green">192</FONT>                    config.getString("escVar"));<a name="line.192"></a>
<FONT color="green">193</FONT>        }<a name="line.193"></a>
<FONT color="green">194</FONT>    <a name="line.194"></a>
<FONT color="green">195</FONT>        /**<a name="line.195"></a>
<FONT color="green">196</FONT>         * Tests accessing and manipulating the interpolator object.<a name="line.196"></a>
<FONT color="green">197</FONT>         *<a name="line.197"></a>
<FONT color="green">198</FONT>         * @param config the configuration to test<a name="line.198"></a>
<FONT color="green">199</FONT>         */<a name="line.199"></a>
<FONT color="green">200</FONT>        public static void testGetInterpolator(AbstractConfiguration config)<a name="line.200"></a>
<FONT color="green">201</FONT>        {<a name="line.201"></a>
<FONT color="green">202</FONT>            config.addProperty("var", "${echo:testVar}");<a name="line.202"></a>
<FONT color="green">203</FONT>            ConfigurationInterpolator interpol = config.getInterpolator();<a name="line.203"></a>
<FONT color="green">204</FONT>            interpol.registerLookup("echo", new StrLookup()<a name="line.204"></a>
<FONT color="green">205</FONT>            {<a name="line.205"></a>
<FONT color="green">206</FONT>                @Override<a name="line.206"></a>
<FONT color="green">207</FONT>                public String lookup(String varName)<a name="line.207"></a>
<FONT color="green">208</FONT>                {<a name="line.208"></a>
<FONT color="green">209</FONT>                    return "Value of variable " + varName;<a name="line.209"></a>
<FONT color="green">210</FONT>                }<a name="line.210"></a>
<FONT color="green">211</FONT>            });<a name="line.211"></a>
<FONT color="green">212</FONT>            assertEquals("Wrong value of echo variable",<a name="line.212"></a>
<FONT color="green">213</FONT>                    "Value of variable testVar", config.getString("var"));<a name="line.213"></a>
<FONT color="green">214</FONT>        }<a name="line.214"></a>
<FONT color="green">215</FONT>    <a name="line.215"></a>
<FONT color="green">216</FONT>        /**<a name="line.216"></a>
<FONT color="green">217</FONT>         * Tests obtaining a configuration with all variables replaced by their<a name="line.217"></a>
<FONT color="green">218</FONT>         * actual values.<a name="line.218"></a>
<FONT color="green">219</FONT>         *<a name="line.219"></a>
<FONT color="green">220</FONT>         * @param config the configuration to test<a name="line.220"></a>
<FONT color="green">221</FONT>         * @return the interpolated configuration<a name="line.221"></a>
<FONT color="green">222</FONT>         */<a name="line.222"></a>
<FONT color="green">223</FONT>        public static Configuration testInterpolatedConfiguration(<a name="line.223"></a>
<FONT color="green">224</FONT>                AbstractConfiguration config)<a name="line.224"></a>
<FONT color="green">225</FONT>        {<a name="line.225"></a>
<FONT color="green">226</FONT>            config.setProperty("applicationRoot", "/home/applicationRoot");<a name="line.226"></a>
<FONT color="green">227</FONT>            config.setProperty("db", "${applicationRoot}/db/hypersonic");<a name="line.227"></a>
<FONT color="green">228</FONT>            config.setProperty("inttest.interpol", "${unknown.property}");<a name="line.228"></a>
<FONT color="green">229</FONT>            config.setProperty("intkey.code",<a name="line.229"></a>
<FONT color="green">230</FONT>                    "${const:java.awt.event.KeyEvent.VK_CANCEL}");<a name="line.230"></a>
<FONT color="green">231</FONT>            config.setProperty("inttest.sysprop", "${sys:java.version}");<a name="line.231"></a>
<FONT color="green">232</FONT>            config.setProperty("inttest.numvalue", "3\\,1415");<a name="line.232"></a>
<FONT color="green">233</FONT>            config.setProperty("inttest.value", "${inttest.numvalue}");<a name="line.233"></a>
<FONT color="green">234</FONT>            config.setProperty("inttest.list", "${db}");<a name="line.234"></a>
<FONT color="green">235</FONT>            config.addProperty("inttest.list", "${inttest.value}");<a name="line.235"></a>
<FONT color="green">236</FONT>    <a name="line.236"></a>
<FONT color="green">237</FONT>            Configuration c = config.interpolatedConfiguration();<a name="line.237"></a>
<FONT color="green">238</FONT>            assertEquals("Property not replaced",<a name="line.238"></a>
<FONT color="green">239</FONT>                    "/home/applicationRoot/db/hypersonic", c.getProperty("db"));<a name="line.239"></a>
<FONT color="green">240</FONT>            assertEquals("Const variable not replaced", KeyEvent.VK_CANCEL,<a name="line.240"></a>
<FONT color="green">241</FONT>                    c.getInt("intkey.code"));<a name="line.241"></a>
<FONT color="green">242</FONT>            assertEquals("Sys property not replaced", System<a name="line.242"></a>
<FONT color="green">243</FONT>                    .getProperty("java.version"), c.getProperty("inttest.sysprop"));<a name="line.243"></a>
<FONT color="green">244</FONT>            assertEquals("Delimiter value not replaced", "3,1415", c<a name="line.244"></a>
<FONT color="green">245</FONT>                    .getProperty("inttest.value"));<a name="line.245"></a>
<FONT color="green">246</FONT>            List&lt;?&gt; lst = (List&lt;?&gt;) c.getProperty("inttest.list");<a name="line.246"></a>
<FONT color="green">247</FONT>            assertEquals("Wrong number of list elements", 2, lst.size());<a name="line.247"></a>
<FONT color="green">248</FONT>            assertEquals("List element 0 not replaced",<a name="line.248"></a>
<FONT color="green">249</FONT>                    "/home/applicationRoot/db/hypersonic", lst.get(0));<a name="line.249"></a>
<FONT color="green">250</FONT>            assertEquals("List element 1 not replaced", "3,1415", lst<a name="line.250"></a>
<FONT color="green">251</FONT>                            .get(1));<a name="line.251"></a>
<FONT color="green">252</FONT>            assertEquals("Unresolvable variable not found",<a name="line.252"></a>
<FONT color="green">253</FONT>                    "${unknown.property}", c.getProperty("inttest.interpol"));<a name="line.253"></a>
<FONT color="green">254</FONT>    <a name="line.254"></a>
<FONT color="green">255</FONT>            return c;<a name="line.255"></a>
<FONT color="green">256</FONT>        }<a name="line.256"></a>
<FONT color="green">257</FONT>    }<a name="line.257"></a>




























































</PRE>
</BODY>
</HTML>
